メインコンテンツまでスキップ
バージョン: APIバージョン 2019-06-09

Charges

Retrieve Charges

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Charges
curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/charges?from=&to=&offset=&limit=&order="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
Date from = 2013-10-20T19:20:30+01:00; // Date |
Date to = 2013-10-20T19:20:30+01:00; // Date |
Integer offset = 56; // Integer |
Integer limit = 56; // Integer |
String order = order_example; // String |
try {
list result = apiInstance.chargesGet(from, to, offset, limit, order);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
Date from = 2013-10-20T19:20:30+01:00; // Date |
Date to = 2013-10-20T19:20:30+01:00; // Date |
Integer offset = 56; // Integer |
Integer limit = 56; // Integer |
String order = order_example; // String |
try {
list result = apiInstance.chargesGet(from, to, offset, limit, order);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesGet");
e.printStackTrace();
}
}
}
Date *from = 2013-10-20T19:20:30+01:00; //  (optional) (default to 1970-01-01T00:00Z)
Date *to = 2013-10-20T19:20:30+01:00; // (optional)
Integer *offset = 56; // (optional) (default to 0)
Integer *limit = 56; // (optional) (default to 20)
String *order = order_example; // (optional) (default to chronological)

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesGetWith:from
to:to
offset:offset
limit:limit
order:order
completionHandler: ^(list output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var opts = {
'from': 2013-10-20T19:20:30+01:00, // {{Date}}
'to': 2013-10-20T19:20:30+01:00, // {{Date}}
'offset': 56, // {{Integer}}
'limit': 56, // {{Integer}}
'order': order_example // {{String}}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesGetExample
{
public void main()
{

var apiInstance = new ChargesApi();
var from = 2013-10-20T19:20:30+01:00; // Date | (optional) (default to 1970-01-01T00:00Z)
var to = 2013-10-20T19:20:30+01:00; // Date | (optional)
var offset = 56; // Integer | (optional) (default to 0)
var limit = 56; // Integer | (optional) (default to 20)
var order = order_example; // String | (optional) (default to chronological)

try
{
list result = apiInstance.chargesGet(from, to, offset, limit, order);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$from = 2013-10-20T19:20:30+01:00; // Date |
$to = 2013-10-20T19:20:30+01:00; // Date |
$offset = 56; // Integer |
$limit = 56; // Integer |
$order = order_example; // String |

try {
$result = $api_instance->chargesGet($from, $to, $offset, $limit, $order);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $from = 2013-10-20T19:20:30+01:00; # Date |
my $to = 2013-10-20T19:20:30+01:00; # Date |
my $offset = 56; # Integer |
my $limit = 56; # Integer |
my $order = order_example; # String |

eval {
my $result = $api_instance->chargesGet(from => $from, to => $to, offset => $offset, limit => $limit, order => $order);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
from = 2013-10-20T19:20:30+01:00 # Date | (optional) (default to 1970-01-01T00:00Z)
to = 2013-10-20T19:20:30+01:00 # Date | (optional)
offset = 56 # Integer | (optional) (default to 0)
limit = 56 # Integer | (optional) (default to 20)
order = order_example # String | (optional) (default to chronological)

try:
api_response = api_instance.charges_get(from=from, to=to, offset=offset, limit=limit, order=order)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesGet: %s\n" % e)

Parameters

NameDescription
fromDate (date-time)
toDate (date-time)
offsetInteger
limitInteger
orderString

Create Charges ID Capture

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Charges ID Capture
curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/charges/{id}/capture"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
Integer captureAmount = 56; // Integer |
try {
charge result = apiInstance.chargesIdCapturePost(id, captureAmount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdCapturePost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
Integer captureAmount = 56; // Integer |
try {
charge result = apiInstance.chargesIdCapturePost(id, captureAmount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdCapturePost");
e.printStackTrace();
}
}
}
String *id = id_example; // 
Integer *captureAmount = 56; // (optional)

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdCapturePostWith:id
captureAmount:captureAmount
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}
var opts = {
'captureAmount': 56 // {{Integer}}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdCapturePost(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdCapturePostExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |
var captureAmount = 56; // Integer | (optional)

try
{
charge result = apiInstance.chargesIdCapturePost(id, captureAmount);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdCapturePost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |
$captureAmount = 56; // Integer |

try {
$result = $api_instance->chargesIdCapturePost($id, $captureAmount);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdCapturePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |
my $captureAmount = 56; # Integer |

eval {
my $result = $api_instance->chargesIdCapturePost(id => $id, captureAmount => $captureAmount);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdCapturePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |
captureAmount = 56 # Integer | (optional)

try:
api_response = api_instance.charges_id_capture_post(id, captureAmount=captureAmount)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdCapturePost: %s\n" % e)

Parameters

NameDescription
id*String Required

Parameters

NameDescription
capture_amountInteger

Retrieve Charges ID Events

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Charges ID Events
curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/charges/{id}/events?from=&to=&offset=&limit=&order="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
Date from = 2013-10-20T19:20:30+01:00; // Date |
Date to = 2013-10-20T19:20:30+01:00; // Date |
Integer offset = 56; // Integer |
Integer limit = 56; // Integer |
String order = order_example; // String |
try {
list result = apiInstance.chargesIdEventsGet(id, from, to, offset, limit, order);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdEventsGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
Date from = 2013-10-20T19:20:30+01:00; // Date |
Date to = 2013-10-20T19:20:30+01:00; // Date |
Integer offset = 56; // Integer |
Integer limit = 56; // Integer |
String order = order_example; // String |
try {
list result = apiInstance.chargesIdEventsGet(id, from, to, offset, limit, order);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdEventsGet");
e.printStackTrace();
}
}
}
String *id = id_example; // 
Date *from = 2013-10-20T19:20:30+01:00; // (optional) (default to 1970-01-01T00:00Z)
Date *to = 2013-10-20T19:20:30+01:00; // (optional)
Integer *offset = 56; // (optional) (default to 0)
Integer *limit = 56; // (optional) (default to 20)
String *order = order_example; // (optional) (default to chronological)

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdEventsGetWith:id
from:from
to:to
offset:offset
limit:limit
order:order
completionHandler: ^(list output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}
var opts = {
'from': 2013-10-20T19:20:30+01:00, // {{Date}}
'to': 2013-10-20T19:20:30+01:00, // {{Date}}
'offset': 56, // {{Integer}}
'limit': 56, // {{Integer}}
'order': order_example // {{String}}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdEventsGet(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdEventsGetExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |
var from = 2013-10-20T19:20:30+01:00; // Date | (optional) (default to 1970-01-01T00:00Z)
var to = 2013-10-20T19:20:30+01:00; // Date | (optional)
var offset = 56; // Integer | (optional) (default to 0)
var limit = 56; // Integer | (optional) (default to 20)
var order = order_example; // String | (optional) (default to chronological)

try
{
list result = apiInstance.chargesIdEventsGet(id, from, to, offset, limit, order);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdEventsGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |
$from = 2013-10-20T19:20:30+01:00; // Date |
$to = 2013-10-20T19:20:30+01:00; // Date |
$offset = 56; // Integer |
$limit = 56; // Integer |
$order = order_example; // String |

try {
$result = $api_instance->chargesIdEventsGet($id, $from, $to, $offset, $limit, $order);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdEventsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |
my $from = 2013-10-20T19:20:30+01:00; # Date |
my $to = 2013-10-20T19:20:30+01:00; # Date |
my $offset = 56; # Integer |
my $limit = 56; # Integer |
my $order = order_example; # String |

eval {
my $result = $api_instance->chargesIdEventsGet(id => $id, from => $from, to => $to, offset => $offset, limit => $limit, order => $order);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdEventsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |
from = 2013-10-20T19:20:30+01:00 # Date | (optional) (default to 1970-01-01T00:00Z)
to = 2013-10-20T19:20:30+01:00 # Date | (optional)
offset = 56 # Integer | (optional) (default to 0)
limit = 56 # Integer | (optional) (default to 20)
order = order_example # String | (optional) (default to chronological)

try:
api_response = api_instance.charges_id_events_get(id, from=from, to=to, offset=offset, limit=limit, order=order)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdEventsGet: %s\n" % e)

Parameters

NameDescription
id*String Required

Parameters

NameDescription
fromDate (date-time)
toDate (date-time)
offsetInteger
limitInteger
orderString

Create Charges ID Expire

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Charges ID Expire
curl -X POST\
-H "Accept: application/json"\
"https://api.omise.co/charges/{id}/expire"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdExpirePost(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdExpirePost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdExpirePost(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdExpirePost");
e.printStackTrace();
}
}
}
String *id = id_example; // 

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdExpirePostWith:id
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdExpirePost(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdExpirePostExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |

try
{
charge result = apiInstance.chargesIdExpirePost(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdExpirePost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |

try {
$result = $api_instance->chargesIdExpirePost($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdExpirePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |

eval {
my $result = $api_instance->chargesIdExpirePost(id => $id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdExpirePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |

try:
api_response = api_instance.charges_id_expire_post(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdExpirePost: %s\n" % e)

Parameters

NameDescription
id*String Required

Retrieve Charges ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Charges ID
curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/charges/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdGet(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdGet(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdGet");
e.printStackTrace();
}
}
}
String *id = id_example; // 

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdGetWith:id
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdGetExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |

try
{
charge result = apiInstance.chargesIdGet(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |

try {
$result = $api_instance->chargesIdGet($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |

eval {
my $result = $api_instance->chargesIdGet(id => $id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |

try:
api_response = api_instance.charges_id_get(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdGet: %s\n" % e)

Parameters

NameDescription
id*String Required

Create Charges ID Mark As Failed

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Charges ID Mark As Failed
curl -X POST\
-H "Accept: application/json"\
"https://api.omise.co/charges/{id}/mark_as_failed"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdMarkAsFailedPost(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdMarkAsFailedPost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdMarkAsFailedPost(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdMarkAsFailedPost");
e.printStackTrace();
}
}
}
String *id = id_example; // 

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdMarkAsFailedPostWith:id
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdMarkAsFailedPost(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdMarkAsFailedPostExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |

try
{
charge result = apiInstance.chargesIdMarkAsFailedPost(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdMarkAsFailedPost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |

try {
$result = $api_instance->chargesIdMarkAsFailedPost($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdMarkAsFailedPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |

eval {
my $result = $api_instance->chargesIdMarkAsFailedPost(id => $id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdMarkAsFailedPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |

try:
api_response = api_instance.charges_id_mark_as_failed_post(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdMarkAsFailedPost: %s\n" % e)

Parameters

NameDescription
id*String Required

Create Charges ID Mark As Paid

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Charges ID Mark As Paid

Parameters

NameDescription
id*String Required

Update Charges ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Update Charges ID
curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/charges/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
String description = description_example; // String |
Object metadata = ; // Object |
try {
charge result = apiInstance.chargesIdPatch(id, description, metadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdPatch");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
String description = description_example; // String |
Object metadata = ; // Object |
try {
charge result = apiInstance.chargesIdPatch(id, description, metadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdPatch");
e.printStackTrace();
}
}
}
String *id = id_example; // 
String *description = description_example; // (optional)
Object *metadata = ; // (optional)

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdPatchWith:id
description:description
metadata:metadata
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}
var opts = {
'description': description_example // {{String}}
'metadata': // {{Object}}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdPatch(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdPatchExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |
var description = description_example; // String | (optional)
var metadata = new Object(); // Object | (optional)

try
{
charge result = apiInstance.chargesIdPatch(id, description, metadata);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdPatch: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |
$description = description_example; // String |
$metadata = ; // Object |

try {
$result = $api_instance->chargesIdPatch($id, $description, $metadata);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |
my $description = description_example; # String |
my $metadata = ; # Object |

eval {
my $result = $api_instance->chargesIdPatch(id => $id, description => $description, metadata => $metadata);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdPatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |
description = description_example # String | (optional)
metadata = # Object | (optional)

try:
api_response = api_instance.charges_id_patch(id, description=description, metadata=metadata)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdPatch: %s\n" % e)

Parameters

NameDescription
id*String Required

Parameters

NameDescription
descriptionString
metadataObject

Create Charges ID Reverse

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Charges ID Reverse
curl -X POST\
-H "Accept: application/json"\
"https://api.omise.co/charges/{id}/reverse"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdReversePost(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdReversePost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String id = id_example; // String |
try {
charge result = apiInstance.chargesIdReversePost(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesIdReversePost");
e.printStackTrace();
}
}
}
String *id = id_example; // 

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesIdReversePostWith:id
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var id = id_example; // {{String}}

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesIdReversePost(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesIdReversePostExample
{
public void main()
{

var apiInstance = new ChargesApi();
var id = id_example; // String |

try
{
charge result = apiInstance.chargesIdReversePost(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesIdReversePost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$id = id_example; // String |

try {
$result = $api_instance->chargesIdReversePost($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesIdReversePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $id = id_example; # String |

eval {
my $result = $api_instance->chargesIdReversePost(id => $id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesIdReversePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
id = id_example # String |

try:
api_response = api_instance.charges_id_reverse_post(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesIdReversePost: %s\n" % e)

Parameters

NameDescription
id*String Required

Create Charges

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Charges
curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/charges"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
Boolean capture = true; // Boolean |
String currency = currency_example; // String |
Integer amount = 56; // Integer |
String ip = ip_example; // String |
Object metadata = ; // Object |
String card = card_example; // String |
String customer = customer_example; // String |
String source = source_example; // String |
String linkedAccount = linkedAccount_example; // String |
String description = description_example; // String |
String returnUri = returnUri_example; // String |
Date expiresAt = 2013-10-20T19:20:30+01:00; // Date |
charges_platform_fee platformFee = ; // charges_platform_fee |
Boolean zeroInterestInstallments = true; // Boolean |
String authorizationType = authorizationType_example; // String |
String firstCharge = firstCharge_example; // String |
String transactionIndicator = transactionIndicator_example; // String |
String recurringReason = recurringReason_example; // String |
array[String] webhookEndpoints = ; // array[String] |
String statementDescriptor = statementDescriptor_example; // String |
try {
charge result = apiInstance.chargesPost(capture, currency, amount, ip, metadata, card, customer, source, linkedAccount, description, returnUri, expiresAt, platformFee, zeroInterestInstallments, authorizationType, firstCharge, transactionIndicator, recurringReason, webhookEndpoints, statementDescriptor);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesPost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
Boolean capture = true; // Boolean |
String currency = currency_example; // String |
Integer amount = 56; // Integer |
String ip = ip_example; // String |
Object metadata = ; // Object |
String card = card_example; // String |
String customer = customer_example; // String |
String source = source_example; // String |
String linkedAccount = linkedAccount_example; // String |
String description = description_example; // String |
String returnUri = returnUri_example; // String |
Date expiresAt = 2013-10-20T19:20:30+01:00; // Date |
charges_platform_fee platformFee = ; // charges_platform_fee |
Boolean zeroInterestInstallments = true; // Boolean |
String authorizationType = authorizationType_example; // String |
String firstCharge = firstCharge_example; // String |
String transactionIndicator = transactionIndicator_example; // String |
String recurringReason = recurringReason_example; // String |
array[String] webhookEndpoints = ; // array[String] |
String statementDescriptor = statementDescriptor_example; // String |
try {
charge result = apiInstance.chargesPost(capture, currency, amount, ip, metadata, card, customer, source, linkedAccount, description, returnUri, expiresAt, platformFee, zeroInterestInstallments, authorizationType, firstCharge, transactionIndicator, recurringReason, webhookEndpoints, statementDescriptor);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesPost");
e.printStackTrace();
}
}
}
Boolean *capture = true; //  (optional)
String *currency = currency_example; // (optional)
Integer *amount = 56; // (optional)
String *ip = ip_example; // (optional)
Object *metadata = ; // (optional)
String *card = card_example; // (optional)
String *customer = customer_example; // (optional)
String *source = source_example; // (optional)
String *linkedAccount = linkedAccount_example; // (optional)
String *description = description_example; // (optional)
String *returnUri = returnUri_example; // (optional)
Date *expiresAt = 2013-10-20T19:20:30+01:00; // (optional)
charges_platform_fee *platformFee = ; // (optional)
Boolean *zeroInterestInstallments = true; // (optional)
String *authorizationType = authorizationType_example; // (optional)
String *firstCharge = firstCharge_example; // (optional)
String *transactionIndicator = transactionIndicator_example; // (optional)
String *recurringReason = recurringReason_example; // (optional)
array[String] *webhookEndpoints = ; // (optional)
String *statementDescriptor = statementDescriptor_example; // (optional)

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesPostWith:capture
currency:currency
amount:amount
ip:ip
metadata:metadata
card:card
customer:customer
source:source
linkedAccount:linkedAccount
description:description
returnUri:returnUri
expiresAt:expiresAt
platformFee:platformFee
zeroInterestInstallments:zeroInterestInstallments
authorizationType:authorizationType
firstCharge:firstCharge
transactionIndicator:transactionIndicator
recurringReason:recurringReason
webhookEndpoints:webhookEndpoints
statementDescriptor:statementDescriptor
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var opts = {
'capture': true // {{Boolean}}
'currency': currency_example // {{String}}
'amount': 56 // {{Integer}}
'ip': ip_example // {{String}}
'metadata': // {{Object}}
'card': card_example // {{String}}
'customer': customer_example // {{String}}
'source': source_example // {{String}}
'linkedAccount': linkedAccount_example // {{String}}
'description': description_example // {{String}}
'returnUri': returnUri_example // {{String}}
'expiresAt': 2013-10-20T19:20:30+01:00 // {{Date}}
'platformFee': // {{charges_platform_fee}}
'zeroInterestInstallments': true // {{Boolean}}
'authorizationType': authorizationType_example // {{String}}
'firstCharge': firstCharge_example // {{String}}
'transactionIndicator': transactionIndicator_example // {{String}}
'recurringReason': recurringReason_example // {{String}}
'webhookEndpoints': // {{array[String]}}
'statementDescriptor': statementDescriptor_example // {{String}}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesPostExample
{
public void main()
{

var apiInstance = new ChargesApi();
var capture = true; // Boolean | (optional)
var currency = currency_example; // String | (optional)
var amount = 56; // Integer | (optional)
var ip = ip_example; // String | (optional)
var metadata = new Object(); // Object | (optional)
var card = card_example; // String | (optional)
var customer = customer_example; // String | (optional)
var source = source_example; // String | (optional)
var linkedAccount = linkedAccount_example; // String | (optional)
var description = description_example; // String | (optional)
var returnUri = returnUri_example; // String | (optional)
var expiresAt = 2013-10-20T19:20:30+01:00; // Date | (optional)
var platformFee = new charges_platform_fee(); // charges_platform_fee | (optional)
var zeroInterestInstallments = true; // Boolean | (optional)
var authorizationType = authorizationType_example; // String | (optional)
var firstCharge = firstCharge_example; // String | (optional)
var transactionIndicator = transactionIndicator_example; // String | (optional)
var recurringReason = recurringReason_example; // String | (optional)
var webhookEndpoints = new array[String](); // array[String] | (optional)
var statementDescriptor = statementDescriptor_example; // String | (optional)

try
{
charge result = apiInstance.chargesPost(capture, currency, amount, ip, metadata, card, customer, source, linkedAccount, description, returnUri, expiresAt, platformFee, zeroInterestInstallments, authorizationType, firstCharge, transactionIndicator, recurringReason, webhookEndpoints, statementDescriptor);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesPost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$capture = true; // Boolean |
$currency = currency_example; // String |
$amount = 56; // Integer |
$ip = ip_example; // String |
$metadata = ; // Object |
$card = card_example; // String |
$customer = customer_example; // String |
$source = source_example; // String |
$linkedAccount = linkedAccount_example; // String |
$description = description_example; // String |
$returnUri = returnUri_example; // String |
$expiresAt = 2013-10-20T19:20:30+01:00; // Date |
$platformFee = ; // charges_platform_fee |
$zeroInterestInstallments = true; // Boolean |
$authorizationType = authorizationType_example; // String |
$firstCharge = firstCharge_example; // String |
$transactionIndicator = transactionIndicator_example; // String |
$recurringReason = recurringReason_example; // String |
$webhookEndpoints = ; // array[String] |
$statementDescriptor = statementDescriptor_example; // String |

try {
$result = $api_instance->chargesPost($capture, $currency, $amount, $ip, $metadata, $card, $customer, $source, $linkedAccount, $description, $returnUri, $expiresAt, $platformFee, $zeroInterestInstallments, $authorizationType, $firstCharge, $transactionIndicator, $recurringReason, $webhookEndpoints, $statementDescriptor);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $capture = true; # Boolean |
my $currency = currency_example; # String |
my $amount = 56; # Integer |
my $ip = ip_example; # String |
my $metadata = ; # Object |
my $card = card_example; # String |
my $customer = customer_example; # String |
my $source = source_example; # String |
my $linkedAccount = linkedAccount_example; # String |
my $description = description_example; # String |
my $returnUri = returnUri_example; # String |
my $expiresAt = 2013-10-20T19:20:30+01:00; # Date |
my $platformFee = ; # charges_platform_fee |
my $zeroInterestInstallments = true; # Boolean |
my $authorizationType = authorizationType_example; # String |
my $firstCharge = firstCharge_example; # String |
my $transactionIndicator = transactionIndicator_example; # String |
my $recurringReason = recurringReason_example; # String |
my $webhookEndpoints = []; # array[String] |
my $statementDescriptor = statementDescriptor_example; # String |

eval {
my $result = $api_instance->chargesPost(capture => $capture, currency => $currency, amount => $amount, ip => $ip, metadata => $metadata, card => $card, customer => $customer, source => $source, linkedAccount => $linkedAccount, description => $description, returnUri => $returnUri, expiresAt => $expiresAt, platformFee => $platformFee, zeroInterestInstallments => $zeroInterestInstallments, authorizationType => $authorizationType, firstCharge => $firstCharge, transactionIndicator => $transactionIndicator, recurringReason => $recurringReason, webhookEndpoints => $webhookEndpoints, statementDescriptor => $statementDescriptor);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
capture = true # Boolean | (optional)
currency = currency_example # String | (optional)
amount = 56 # Integer | (optional)
ip = ip_example # String | (optional)
metadata = # Object | (optional)
card = card_example # String | (optional)
customer = customer_example # String | (optional)
source = source_example # String | (optional)
linkedAccount = linkedAccount_example # String | (optional)
description = description_example # String | (optional)
returnUri = returnUri_example # String | (optional)
expiresAt = 2013-10-20T19:20:30+01:00 # Date | (optional)
platformFee = # charges_platform_fee | (optional)
zeroInterestInstallments = true # Boolean | (optional)
authorizationType = authorizationType_example # String | (optional)
firstCharge = firstCharge_example # String | (optional)
transactionIndicator = transactionIndicator_example # String | (optional)
recurringReason = recurringReason_example # String | (optional)
webhookEndpoints = # array[String] | (optional)
statementDescriptor = statementDescriptor_example # String | (optional)

try:
api_response = api_instance.charges_post(capture=capture, currency=currency, amount=amount, ip=ip, metadata=metadata, card=card, customer=customer, source=source, linkedAccount=linkedAccount, description=description, returnUri=returnUri, expiresAt=expiresAt, platformFee=platformFee, zeroInterestInstallments=zeroInterestInstallments, authorizationType=authorizationType, firstCharge=firstCharge, transactionIndicator=transactionIndicator, recurringReason=recurringReason, webhookEndpoints=webhookEndpoints, statementDescriptor=statementDescriptor)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesPost: %s\n" % e)

Parameters

NameDescription
captureBoolean
currencyString (currency)
amountInteger
ipString
metadataObject
cardString
customerString
sourceString
linked_accountString
descriptionString
return_uriString
expires_atDate (date-time)
platform_feecharges_platform_fee
zero_interest_installmentsBoolean
authorization_typeString
first_chargeString
transaction_indicatorString
recurring_reasonString
webhook_endpointsarray[String]
statement_descriptorString

Retrieve Charges Search

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Charges Search
curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/charges/search?scope=&query=&filters[amount]=&filters[authorized]=&filters[capture]=&filters[capture_id]=&filters[captured]=&filters[card_last_digits]=&filters[created]=&filters[currency]=&filters[customer_present]=&filters[disputed]=&filters[failure_code]=&filters[is_installment]=&filters[refunded]=&filters[refund_amount]=&filters[reversed]=&filters[safe]=&filters[scheduled]=&filters[source_of_fund]=&filters[source_type]=&filters[status]=&filters[voided]=&filters[installment_terms]=&filters[acquirer_reference_number]="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChargesApi;

import java.io.File;
import java.util.*;

public class ChargesApiExample {

public static void main(String[] args) {

ChargesApi apiInstance = new ChargesApi();
String scope = scope_example; // String |
String query = query_example; // String |
Integer filters[amount] = 56; // Integer |
Boolean filters[authorized] = true; // Boolean |
Boolean filters[capture] = true; // Boolean |
String filters[captureId] = filters[captureId]_example; // String |
Boolean filters[captured] = true; // Boolean |
String filters[cardLastDigits] = filters[cardLastDigits]_example; // String |
Date filters[created] = 2013-10-20T19:20:30+01:00; // Date |
String filters[currency] = filters[currency]_example; // String |
Boolean filters[customerPresent] = true; // Boolean |
Boolean filters[disputed] = true; // Boolean |
String filters[failureCode] = filters[failureCode]_example; // String |
Boolean filters[isInstallment] = true; // Boolean |
Integer filters[refunded] = 56; // Integer |
Integer filters[refundAmount] = 56; // Integer |
Boolean filters[reversed] = true; // Boolean |
Boolean filters[safe] = true; // Boolean |
Boolean filters[scheduled] = true; // Boolean |
String filters[sourceOfFund] = filters[sourceOfFund]_example; // String |
String filters[sourceType] = filters[sourceType]_example; // String |
String filters[status] = filters[status]_example; // String |
Boolean filters[voided] = true; // Boolean |
Integer filters[installmentTerms] = 56; // Integer |
String filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example; // String |
try {
charge result = apiInstance.chargesSearchGet(scope, query, filters[amount], filters[authorized], filters[capture], filters[captureId], filters[captured], filters[cardLastDigits], filters[created], filters[currency], filters[customerPresent], filters[disputed], filters[failureCode], filters[isInstallment], filters[refunded], filters[refundAmount], filters[reversed], filters[safe], filters[scheduled], filters[sourceOfFund], filters[sourceType], filters[status], filters[voided], filters[installmentTerms], filters[acquirerReferenceNumber]);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesSearchGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ChargesApi;

public class ChargesApiExample {

public static void main(String[] args) {
ChargesApi apiInstance = new ChargesApi();
String scope = scope_example; // String |
String query = query_example; // String |
Integer filters[amount] = 56; // Integer |
Boolean filters[authorized] = true; // Boolean |
Boolean filters[capture] = true; // Boolean |
String filters[captureId] = filters[captureId]_example; // String |
Boolean filters[captured] = true; // Boolean |
String filters[cardLastDigits] = filters[cardLastDigits]_example; // String |
Date filters[created] = 2013-10-20T19:20:30+01:00; // Date |
String filters[currency] = filters[currency]_example; // String |
Boolean filters[customerPresent] = true; // Boolean |
Boolean filters[disputed] = true; // Boolean |
String filters[failureCode] = filters[failureCode]_example; // String |
Boolean filters[isInstallment] = true; // Boolean |
Integer filters[refunded] = 56; // Integer |
Integer filters[refundAmount] = 56; // Integer |
Boolean filters[reversed] = true; // Boolean |
Boolean filters[safe] = true; // Boolean |
Boolean filters[scheduled] = true; // Boolean |
String filters[sourceOfFund] = filters[sourceOfFund]_example; // String |
String filters[sourceType] = filters[sourceType]_example; // String |
String filters[status] = filters[status]_example; // String |
Boolean filters[voided] = true; // Boolean |
Integer filters[installmentTerms] = 56; // Integer |
String filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example; // String |
try {
charge result = apiInstance.chargesSearchGet(scope, query, filters[amount], filters[authorized], filters[capture], filters[captureId], filters[captured], filters[cardLastDigits], filters[created], filters[currency], filters[customerPresent], filters[disputed], filters[failureCode], filters[isInstallment], filters[refunded], filters[refundAmount], filters[reversed], filters[safe], filters[scheduled], filters[sourceOfFund], filters[sourceType], filters[status], filters[voided], filters[installmentTerms], filters[acquirerReferenceNumber]);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChargesApi#chargesSearchGet");
e.printStackTrace();
}
}
}
String *scope = scope_example; //  (optional) (default to charge)
String *query = query_example; // (optional)
Integer *filters[amount] = 56; // (optional)
Boolean *filters[authorized] = true; // (optional)
Boolean *filters[capture] = true; // (optional)
String *filters[captureId] = filters[captureId]_example; // (optional)
Boolean *filters[captured] = true; // (optional)
String *filters[cardLastDigits] = filters[cardLastDigits]_example; // (optional)
Date *filters[created] = 2013-10-20T19:20:30+01:00; // (optional)
String *filters[currency] = filters[currency]_example; // (optional)
Boolean *filters[customerPresent] = true; // (optional)
Boolean *filters[disputed] = true; // (optional)
String *filters[failureCode] = filters[failureCode]_example; // (optional)
Boolean *filters[isInstallment] = true; // (optional)
Integer *filters[refunded] = 56; // (optional)
Integer *filters[refundAmount] = 56; // (optional)
Boolean *filters[reversed] = true; // (optional)
Boolean *filters[safe] = true; // (optional)
Boolean *filters[scheduled] = true; // (optional)
String *filters[sourceOfFund] = filters[sourceOfFund]_example; // (optional)
String *filters[sourceType] = filters[sourceType]_example; // (optional)
String *filters[status] = filters[status]_example; // (optional)
Boolean *filters[voided] = true; // (optional)
Integer *filters[installmentTerms] = 56; // (optional)
String *filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example; // (optional)

ChargesApi *apiInstance = [[ChargesApi alloc] init];

[apiInstance chargesSearchGetWith:scope
query:query
filters[amount]:filters[amount]
filters[authorized]:filters[authorized]
filters[capture]:filters[capture]
filters[captureId]:filters[captureId]
filters[captured]:filters[captured]
filters[cardLastDigits]:filters[cardLastDigits]
filters[created]:filters[created]
filters[currency]:filters[currency]
filters[customerPresent]:filters[customerPresent]
filters[disputed]:filters[disputed]
filters[failureCode]:filters[failureCode]
filters[isInstallment]:filters[isInstallment]
filters[refunded]:filters[refunded]
filters[refundAmount]:filters[refundAmount]
filters[reversed]:filters[reversed]
filters[safe]:filters[safe]
filters[scheduled]:filters[scheduled]
filters[sourceOfFund]:filters[sourceOfFund]
filters[sourceType]:filters[sourceType]
filters[status]:filters[status]
filters[voided]:filters[voided]
filters[installmentTerms]:filters[installmentTerms]
filters[acquirerReferenceNumber]:filters[acquirerReferenceNumber]
completionHandler: ^(charge output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OmiseApi = require('omise_api');

var api = new OmiseApi.ChargesApi()
var opts = {
'scope': scope_example, // {{String}}
'query': query_example, // {{String}}
'filters[amount]': 56, // {{Integer}}
'filters[authorized]': true, // {{Boolean}}
'filters[capture]': true, // {{Boolean}}
'filters[captureId]': filters[captureId]_example, // {{String}}
'filters[captured]': true, // {{Boolean}}
'filters[cardLastDigits]': filters[cardLastDigits]_example, // {{String}}
'filters[created]': 2013-10-20T19:20:30+01:00, // {{Date}}
'filters[currency]': filters[currency]_example, // {{String}}
'filters[customerPresent]': true, // {{Boolean}}
'filters[disputed]': true, // {{Boolean}}
'filters[failureCode]': filters[failureCode]_example, // {{String}}
'filters[isInstallment]': true, // {{Boolean}}
'filters[refunded]': 56, // {{Integer}}
'filters[refundAmount]': 56, // {{Integer}}
'filters[reversed]': true, // {{Boolean}}
'filters[safe]': true, // {{Boolean}}
'filters[scheduled]': true, // {{Boolean}}
'filters[sourceOfFund]': filters[sourceOfFund]_example, // {{String}}
'filters[sourceType]': filters[sourceType]_example, // {{String}}
'filters[status]': filters[status]_example, // {{String}}
'filters[voided]': true, // {{Boolean}}
'filters[installmentTerms]': 56, // {{Integer}}
'filters[acquirerReferenceNumber]': filters[acquirerReferenceNumber]_example // {{String}}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.chargesSearchGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class chargesSearchGetExample
{
public void main()
{

var apiInstance = new ChargesApi();
var scope = scope_example; // String | (optional) (default to charge)
var query = query_example; // String | (optional)
var filters[amount] = 56; // Integer | (optional)
var filters[authorized] = true; // Boolean | (optional)
var filters[capture] = true; // Boolean | (optional)
var filters[captureId] = filters[captureId]_example; // String | (optional)
var filters[captured] = true; // Boolean | (optional)
var filters[cardLastDigits] = filters[cardLastDigits]_example; // String | (optional)
var filters[created] = 2013-10-20T19:20:30+01:00; // Date | (optional)
var filters[currency] = filters[currency]_example; // String | (optional)
var filters[customerPresent] = true; // Boolean | (optional)
var filters[disputed] = true; // Boolean | (optional)
var filters[failureCode] = filters[failureCode]_example; // String | (optional)
var filters[isInstallment] = true; // Boolean | (optional)
var filters[refunded] = 56; // Integer | (optional)
var filters[refundAmount] = 56; // Integer | (optional)
var filters[reversed] = true; // Boolean | (optional)
var filters[safe] = true; // Boolean | (optional)
var filters[scheduled] = true; // Boolean | (optional)
var filters[sourceOfFund] = filters[sourceOfFund]_example; // String | (optional)
var filters[sourceType] = filters[sourceType]_example; // String | (optional)
var filters[status] = filters[status]_example; // String | (optional)
var filters[voided] = true; // Boolean | (optional)
var filters[installmentTerms] = 56; // Integer | (optional)
var filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example; // String | (optional)

try
{
charge result = apiInstance.chargesSearchGet(scope, query, filters[amount], filters[authorized], filters[capture], filters[captureId], filters[captured], filters[cardLastDigits], filters[created], filters[currency], filters[customerPresent], filters[disputed], filters[failureCode], filters[isInstallment], filters[refunded], filters[refundAmount], filters[reversed], filters[safe], filters[scheduled], filters[sourceOfFund], filters[sourceType], filters[status], filters[voided], filters[installmentTerms], filters[acquirerReferenceNumber]);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ChargesApi.chargesSearchGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChargesApi();
$scope = scope_example; // String |
$query = query_example; // String |
$filters[amount] = 56; // Integer |
$filters[authorized] = true; // Boolean |
$filters[capture] = true; // Boolean |
$filters[captureId] = filters[captureId]_example; // String |
$filters[captured] = true; // Boolean |
$filters[cardLastDigits] = filters[cardLastDigits]_example; // String |
$filters[created] = 2013-10-20T19:20:30+01:00; // Date |
$filters[currency] = filters[currency]_example; // String |
$filters[customerPresent] = true; // Boolean |
$filters[disputed] = true; // Boolean |
$filters[failureCode] = filters[failureCode]_example; // String |
$filters[isInstallment] = true; // Boolean |
$filters[refunded] = 56; // Integer |
$filters[refundAmount] = 56; // Integer |
$filters[reversed] = true; // Boolean |
$filters[safe] = true; // Boolean |
$filters[scheduled] = true; // Boolean |
$filters[sourceOfFund] = filters[sourceOfFund]_example; // String |
$filters[sourceType] = filters[sourceType]_example; // String |
$filters[status] = filters[status]_example; // String |
$filters[voided] = true; // Boolean |
$filters[installmentTerms] = 56; // Integer |
$filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example; // String |

try {
$result = $api_instance->chargesSearchGet($scope, $query, $filters[amount], $filters[authorized], $filters[capture], $filters[captureId], $filters[captured], $filters[cardLastDigits], $filters[created], $filters[currency], $filters[customerPresent], $filters[disputed], $filters[failureCode], $filters[isInstallment], $filters[refunded], $filters[refundAmount], $filters[reversed], $filters[safe], $filters[scheduled], $filters[sourceOfFund], $filters[sourceType], $filters[status], $filters[voided], $filters[installmentTerms], $filters[acquirerReferenceNumber]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChargesApi->chargesSearchGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChargesApi;

my $api_instance = WWW::SwaggerClient::ChargesApi->new();
my $scope = scope_example; # String |
my $query = query_example; # String |
my $filters[amount] = 56; # Integer |
my $filters[authorized] = true; # Boolean |
my $filters[capture] = true; # Boolean |
my $filters[captureId] = filters[captureId]_example; # String |
my $filters[captured] = true; # Boolean |
my $filters[cardLastDigits] = filters[cardLastDigits]_example; # String |
my $filters[created] = 2013-10-20T19:20:30+01:00; # Date |
my $filters[currency] = filters[currency]_example; # String |
my $filters[customerPresent] = true; # Boolean |
my $filters[disputed] = true; # Boolean |
my $filters[failureCode] = filters[failureCode]_example; # String |
my $filters[isInstallment] = true; # Boolean |
my $filters[refunded] = 56; # Integer |
my $filters[refundAmount] = 56; # Integer |
my $filters[reversed] = true; # Boolean |
my $filters[safe] = true; # Boolean |
my $filters[scheduled] = true; # Boolean |
my $filters[sourceOfFund] = filters[sourceOfFund]_example; # String |
my $filters[sourceType] = filters[sourceType]_example; # String |
my $filters[status] = filters[status]_example; # String |
my $filters[voided] = true; # Boolean |
my $filters[installmentTerms] = 56; # Integer |
my $filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example; # String |

eval {
my $result = $api_instance->chargesSearchGet(scope => $scope, query => $query, filters[amount] => $filters[amount], filters[authorized] => $filters[authorized], filters[capture] => $filters[capture], filters[captureId] => $filters[captureId], filters[captured] => $filters[captured], filters[cardLastDigits] => $filters[cardLastDigits], filters[created] => $filters[created], filters[currency] => $filters[currency], filters[customerPresent] => $filters[customerPresent], filters[disputed] => $filters[disputed], filters[failureCode] => $filters[failureCode], filters[isInstallment] => $filters[isInstallment], filters[refunded] => $filters[refunded], filters[refundAmount] => $filters[refundAmount], filters[reversed] => $filters[reversed], filters[safe] => $filters[safe], filters[scheduled] => $filters[scheduled], filters[sourceOfFund] => $filters[sourceOfFund], filters[sourceType] => $filters[sourceType], filters[status] => $filters[status], filters[voided] => $filters[voided], filters[installmentTerms] => $filters[installmentTerms], filters[acquirerReferenceNumber] => $filters[acquirerReferenceNumber]);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ChargesApi->chargesSearchGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChargesApi()
scope = scope_example # String | (optional) (default to charge)
query = query_example # String | (optional)
filters[amount] = 56 # Integer | (optional)
filters[authorized] = true # Boolean | (optional)
filters[capture] = true # Boolean | (optional)
filters[captureId] = filters[captureId]_example # String | (optional)
filters[captured] = true # Boolean | (optional)
filters[cardLastDigits] = filters[cardLastDigits]_example # String | (optional)
filters[created] = 2013-10-20T19:20:30+01:00 # Date | (optional)
filters[currency] = filters[currency]_example # String | (optional)
filters[customerPresent] = true # Boolean | (optional)
filters[disputed] = true # Boolean | (optional)
filters[failureCode] = filters[failureCode]_example # String | (optional)
filters[isInstallment] = true # Boolean | (optional)
filters[refunded] = 56 # Integer | (optional)
filters[refundAmount] = 56 # Integer | (optional)
filters[reversed] = true # Boolean | (optional)
filters[safe] = true # Boolean | (optional)
filters[scheduled] = true # Boolean | (optional)
filters[sourceOfFund] = filters[sourceOfFund]_example # String | (optional)
filters[sourceType] = filters[sourceType]_example # String | (optional)
filters[status] = filters[status]_example # String | (optional)
filters[voided] = true # Boolean | (optional)
filters[installmentTerms] = 56 # Integer | (optional)
filters[acquirerReferenceNumber] = filters[acquirerReferenceNumber]_example # String | (optional)

try:
api_response = api_instance.charges_search_get(scope=scope, query=query, filters[amount]=filters[amount], filters[authorized]=filters[authorized], filters[capture]=filters[capture], filters[captureId]=filters[captureId], filters[captured]=filters[captured], filters[cardLastDigits]=filters[cardLastDigits], filters[created]=filters[created], filters[currency]=filters[currency], filters[customerPresent]=filters[customerPresent], filters[disputed]=filters[disputed], filters[failureCode]=filters[failureCode], filters[isInstallment]=filters[isInstallment], filters[refunded]=filters[refunded], filters[refundAmount]=filters[refundAmount], filters[reversed]=filters[reversed], filters[safe]=filters[safe], filters[scheduled]=filters[scheduled], filters[sourceOfFund]=filters[sourceOfFund], filters[sourceType]=filters[sourceType], filters[status]=filters[status], filters[voided]=filters[voided], filters[installmentTerms]=filters[installmentTerms], filters[acquirerReferenceNumber]=filters[acquirerReferenceNumber])
pprint(api_response)
except ApiException as e:
print("Exception when calling ChargesApi->chargesSearchGet: %s\n" % e)

Parameters

NameDescription
scopeString
queryString
filters[amount]Integer
filters[authorized]Boolean
filters[capture]Boolean
filters[capture_id]String
filters[captured]Boolean
filters[card_last_digits]String
filters[created]Date (date-time)
filters[currency]String
filters[customer_present]Boolean
filters[disputed]Boolean
filters[failure_code]String
filters[is_installment]Boolean
filters[refunded]Integer
filters[refund_amount]Integer
filters[reversed]Boolean
filters[safe]Boolean
filters[scheduled]Boolean
filters[source_of_fund]String
filters[source_type]String
filters[status]String
filters[voided]Boolean
filters[installment_terms]Integer
filters[acquirer_reference_number]String

Responses

Status: 200

 {
"object": {
"pattern": "charge",
"type": "string",
"default": "charge"
},
"id": {
"pattern": "chrg_[0-9a-z]+",
"type": "string"
},
"location": {
"type": "string"
},
"amount": {
"type": "integer"
},
"authorization_type": {
"type": "string"
},
"authorized_amount": {
"type": "integer"
},
"captured_amount": {
"type": "integer"
},
"acquirer_reference_number": {
"type": "string",
"nullable": true
},
"net": {
"type": "integer"
},
"fee": {
"type": "integer"
},
"fee_vat": {
"type": "integer"
},
"interest": {
"type": "integer"
},
"interest_vat": {
"type": "integer"
},
"funding_amount": {
"type": "integer"
},
"refunded_amount": {
"type": "integer"
},
"transaction_fees": {
"type": "object",
"properties": {
"fee_flat": {
"type": "integer"
},
"fee_rate": {
"type": "number",
"format": "float"
},
"vat_rate": {
"type": "number",
"format": "float"
}
}
},
"platform_fee": {
"type": "object",
"properties": {
"fixed": {
"type": "integer"
},
"amount": {
"type": "integer"
},
"percentage": {
"type": "string"
}
}
},
"unmanaged_payment": {
"type": "object",
"properties": {
"authorization_code": {
"type": "string"
},
"backend_name": {
"type": "string"
},
"iin": {
"type": "string"
},
"merchant_reference": {
"type": "string"
}
}
},
"three_ds_info": {
"type": "object",
"properties": {
"three_ds_version": {
"type": "string"
},
"authenticated_at": {
"type": "string",
"format": "date-time"
},
"eci": {
"type": "string"
},
"transaction_status": {
"type": "string"
},
"acs_url": {
"type": "string"
}
}
},
"currency": {
"type": "string",
"format": "currency"
},
"funding_currency": {
"type": "string",
"format": "currency"
},
"ip": {
"type": "string",
"nullable": true
},
"refunds": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"link": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "link",
"type": "string",
"default": "link"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"multiple": {
"type": "boolean",
"enum": [
true,
false
]
},
"used": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"charges": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
},
"payment_uri": {
"type": "string",
"format": "uri"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"used_at": {
"type": "string",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"format": "date-time"
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"description": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"missing_3ds_fields": {
"type": "object"
},
"card": {
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"source": {
"type": "object",
"properties": {
"object": {
"pattern": "source",
"type": "string",
"default": "source"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"amount": {
"type": "integer"
},
"barcode": {
"type": "string"
},
"bank": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"currency": {
"type": "string",
"format": "currency"
},
"email": {
"type": "string"
},
"flow": {
"type": "string",
"enum": [
"redirect",
"offline",
"app_redirect"
]
},
"installment_term": {
"type": "integer"
},
"ip": {
"type": "string"
},
"absorption_type": {
"type": "string",
"enum": [
"merchant",
"customer"
]
},
"name": {
"type": "string"
},
"mobile_number": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"platform_type": {
"type": "string"
},
"scannable_code": {
"type": "object",
"properties": {
"object": {
"pattern": "barcode",
"type": "string",
"default": "barcode"
},
"type": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"object": {
"pattern": "document",
"type": "string",
"default": "document"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"id": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"filename": {
"type": "string"
},
"location": {
"type": "string"
},
"kind": {
"type": "string"
},
"download_uri": {
"type": "string",
"format": "uri"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"raw_data": {
"type": "string"
}
}
},
"qr_settings": {
"type": "object",
"properties": {
"image_type": {
"type": "string"
}
}
},
"billing": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
}
}
},
"shipping": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
}
}
},
"items": {
"type": "array",
"items": {}
},
"references": {
"type": "object",
"properties": {
"expires_at": {
"type": "string",
"format": "date-time"
},
"device_id": {
"type": "string"
},
"customer_amount": {
"type": "integer"
},
"customer_currency": {
"type": "string"
},
"customer_exchange_rate": {
"type": "number",
"format": "float"
},
"omise_tax_id": {
"type": "string"
},
"reference_number_1": {
"type": "string"
},
"reference_number_2": {
"type": "string"
},
"barcode": {
"type": "string"
},
"payment_code": {
"type": "string"
},
"va_code": {
"type": "string"
}
}
},
"provider_references": {
"type": "object",
"properties": {
"reference_number_1": {
"type": "string"
},
"reference_number_2": {
"type": "string"
},
"buyer_name": {
"type": "string"
}
}
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"terminal_id": {
"type": "string"
},
"type": {
"type": "string"
},
"zero_interest_installments": {
"type": "boolean",
"enum": [
true,
false
]
},
"charge_status": {
"type": "string",
"enum": [
"failed",
"expired",
"pending",
"reversed",
"successful",
"unknown"
]
},
"receipt_amount": {
"type": "integer"
},
"discounts": {
"type": "array",
"items": {},
"default": []
},
"promotion_code": {
"type": "string"
},
"supplier_id": {
"type": "string"
}
}
},
"schedule": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "schedule",
"type": "string",
"default": "schedule"
},
"id": {
"pattern": "schd_[0-9a-z]+",
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"every": {
"type": "integer"
},
"occurrences": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"on": {
"type": "object",
"properties": {
"days_of_month": {
"type": "array",
"items": {}
},
"weekday_of_month": {
"type": "string"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
}
}
},
"in_words": {
"type": "string"
},
"period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"status": {
"type": "string",
"enum": [
"running",
"active",
"expiring",
"expired",
"deleted",
"suspended"
]
},
"active": {
"type": "boolean",
"enum": [
true,
false
]
},
"state": {
"type": "string",
"enum": [
"Active",
"Pause"
]
},
"charge": {
"type": "object",
"properties": {
"object": {
"pattern": "charge_schedule",
"type": "string",
"default": "charge_schedule"
},
"id": {
"pattern": "rchg_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"default_card": {
"type": "boolean",
"enum": [
true,
false
]
},
"card": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"customer": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "customer",
"type": "string",
"default": "customer"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"metadata": {
"type": "object",
"default": {}
},
"cards": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"default_card": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"linked_accounts": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"description": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"linked_account": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "linked_account",
"type": "string",
"default": "linked_account"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"registration_uri": {
"type": "string",
"format": "uri"
},
"return_uri": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"deleted",
"pending",
"successful"
]
},
"last_digits": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"failure_code": {
"type": "string",
"nullable": true
},
"failure_message": {
"type": "string",
"nullable": true
},
"registered_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"description": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"transfer": {
"type": "object",
"properties": {
"object": {
"pattern": "transfer_schedule",
"type": "string",
"default": "transfer_schedule"
},
"id": {
"pattern": "rtrf_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"amount": {
"type": "integer",
"nullable": true
},
"currency": {
"type": "string",
"format": "currency"
},
"percentage_of_balance": {
"type": "number",
"format": "float",
"nullable": true
},
"recipient": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "recipient",
"type": "string",
"default": "recipient"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"bank_account": {
"type": "object",
"properties": {
"object": {
"pattern": "bank_account",
"type": "string",
"default": "bank_account"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"account_number": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"normal",
"current"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"brand": {
"type": "string"
},
"bank_code": {
"type": "string"
},
"branch_code": {
"type": "string"
}
}
},
"active": {
"type": "boolean",
"enum": [
true,
false
]
},
"default": {
"type": "boolean",
"enum": [
true,
false
]
},
"verified": {
"type": "boolean",
"enum": [
true,
false
]
},
"description": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"failure_code": {
"type": "string",
"nullable": true,
"enum": [
"name_mismatch",
"account_not_found",
"bank_not_found"
]
},
"name": {
"type": "string"
},
"tax_id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"individual",
"corporation"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"schedule": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "schedule",
"type": "string",
"default": "schedule"
},
"id": {
"pattern": "schd_[0-9a-z]+",
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"every": {
"type": "integer"
},
"occurrences": {
"$ref": "#/components/schemas/list"
},
"on": {
"$ref": "#/components/schemas/schedule_on"
},
"in_words": {
"type": "string"
},
"period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"status": {
"type": "string",
"enum": [
"running",
"active",
"expiring",
"expired",
"deleted",
"suspended"
]
},
"active": {
"type": "boolean",
"enum": [
true,
false
]
},
"state": {
"type": "string",
"enum": [
"Active",
"Pause"
]
},
"charge": {
"$ref": "#/components/schemas/charge_schedule"
},
"transfer": {
"$ref": "#/components/schemas/transfer_schedule"
},
"next_occurrences_on": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"ended_at": {
"type": "string",
"format": "date-time"
},
"start_on": {
"type": "string",
"format": "date"
},
"end_on": {
"type": "string",
"format": "date"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"execute_time": {
"type": "string",
"nullable": true
},
"deleted_by": {
"type": "string",
"nullable": true
},
"merchant_name": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"metadata": {
"type": "object",
"default": {}
},
"verified_at": {
"type": "string",
"format": "date-time"
},
"activated_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"is_realtime_payout": {
"type": "boolean",
"nullable": true,
"enum": [
true,
false
]
}
}
},
"next_occurrences_on": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"ended_at": {
"type": "string",
"format": "date-time"
},
"start_on": {
"type": "string",
"format": "date"
},
"end_on": {
"type": "string",
"format": "date"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"execute_time": {
"type": "string",
"nullable": true
},
"deleted_by": {
"type": "string",
"nullable": true
},
"merchant_name": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"linked_account": {
"type": "object",
"properties": {
"object": {
"pattern": "linked_account",
"type": "string",
"default": "linked_account"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"registration_uri": {
"type": "string",
"format": "uri"
},
"return_uri": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"deleted",
"pending",
"successful"
]
},
"last_digits": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"failure_code": {
"type": "string",
"nullable": true
},
"failure_message": {
"type": "string",
"nullable": true
},
"registered_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"customer": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "customer",
"type": "string",
"default": "customer"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"metadata": {
"type": "object",
"default": {}
},
"cards": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"default_card": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"linked_accounts": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"description": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"dispute": {
"type": "object",
"properties": {
"object": {
"pattern": "dispute",
"type": "string",
"default": "dispute"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"funding_amount": {
"type": "integer"
},
"funding_currency": {
"type": "string",
"format": "currency"
},
"metadata": {
"type": "object",
"default": {}
},
"charge": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "charge",
"type": "string",
"default": "charge"
},
"id": {
"pattern": "chrg_[0-9a-z]+",
"type": "string"
},
"location": {
"type": "string"
},
"amount": {
"type": "integer"
},
"authorization_type": {
"type": "string"
},
"authorized_amount": {
"type": "integer"
},
"captured_amount": {
"type": "integer"
},
"acquirer_reference_number": {
"type": "string",
"nullable": true
},
"net": {
"type": "integer"
},
"fee": {
"type": "integer"
},
"fee_vat": {
"type": "integer"
},
"interest": {
"type": "integer"
},
"interest_vat": {
"type": "integer"
},
"funding_amount": {
"type": "integer"
},
"refunded_amount": {
"type": "integer"
},
"transaction_fees": {
"type": "object",
"properties": {
"fee_flat": {
"type": "integer"
},
"fee_rate": {
"type": "number",
"format": "float"
},
"vat_rate": {
"type": "number",
"format": "float"
}
}
},
"platform_fee": {
"type": "object",
"properties": {
"fixed": {
"type": "integer"
},
"amount": {
"type": "integer"
},
"percentage": {
"type": "string"
}
}
},
"unmanaged_payment": {
"type": "object",
"properties": {
"authorization_code": {
"type": "string"
},
"backend_name": {
"type": "string"
},
"iin": {
"type": "string"
},
"merchant_reference": {
"type": "string"
}
}
},
"three_ds_info": {
"type": "object",
"properties": {
"three_ds_version": {
"type": "string"
},
"authenticated_at": {
"type": "string",
"format": "date-time"
},
"eci": {
"type": "string"
},
"transaction_status": {
"type": "string"
},
"acs_url": {
"type": "string"
}
}
},
"currency": {
"type": "string",
"format": "currency"
},
"funding_currency": {
"type": "string",
"format": "currency"
},
"ip": {
"type": "string",
"nullable": true
},
"refunds": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"link": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "link",
"type": "string",
"default": "link"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"multiple": {
"type": "boolean",
"enum": [
true,
false
]
},
"used": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"charges": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
},
"payment_uri": {
"type": "string",
"format": "uri"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"used_at": {
"type": "string",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"format": "date-time"
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"description": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"missing_3ds_fields": {
"type": "object"
},
"card": {
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"source": {
"type": "object",
"properties": {
"object": {
"pattern": "source",
"type": "string",
"default": "source"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"amount": {
"type": "integer"
},
"barcode": {
"type": "string"
},
"bank": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"currency": {
"type": "string",
"format": "currency"
},
"email": {
"type": "string"
},
"flow": {
"type": "string",
"enum": [
"redirect",
"offline",
"app_redirect"
]
},
"installment_term": {
"type": "integer"
},
"ip": {
"type": "string"
},
"absorption_type": {
"type": "string",
"enum": [
"merchant",
"customer"
]
},
"name": {
"type": "string"
},
"mobile_number": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"platform_type": {
"type": "string"
},
"scannable_code": {
"type": "object",
"properties": {
"object": {
"pattern": "barcode",
"type": "string",
"default": "barcode"
},
"type": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"object": {
"pattern": "document",
"type": "string",
"default": "document"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"id": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"filename": {
"type": "string"
},
"location": {
"type": "string"
},
"kind": {
"type": "string"
},
"download_uri": {
"type": "string",
"format": "uri"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"raw_data": {
"type": "string"
}
}
},
"qr_settings": {
"type": "object",
"properties": {
"image_type": {
"type": "string"
}
}
},
"billing": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
}
}
},
"shipping": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
}
}
},
"items": {
"type": "array",
"items": {}
},
"references": {
"type": "object",
"properties": {
"expires_at": {
"type": "string",
"format": "date-time"
},
"device_id": {
"type": "string"
},
"customer_amount": {
"type": "integer"
},
"customer_currency": {
"type": "string"
},
"customer_exchange_rate": {
"type": "number",
"format": "float"
},
"omise_tax_id": {
"type": "string"
},
"reference_number_1": {
"type": "string"
},
"reference_number_2": {
"type": "string"
},
"barcode": {
"type": "string"
},
"payment_code": {
"type": "string"
},
"va_code": {
"type": "string"
}
}
},
"provider_references": {
"type": "object",
"properties": {
"reference_number_1": {
"type": "string"
},
"reference_number_2": {
"type": "string"
},
"buyer_name": {
"type": "string"
}
}
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"terminal_id": {
"type": "string"
},
"type": {
"type": "string"
},
"zero_interest_installments": {
"type": "boolean",
"enum": [
true,
false
]
},
"charge_status": {
"type": "string",
"enum": [
"failed",
"expired",
"pending",
"reversed",
"successful",
"unknown"
]
},
"receipt_amount": {
"type": "integer"
},
"discounts": {
"type": "array",
"items": {},
"default": []
},
"promotion_code": {
"type": "string"
},
"supplier_id": {
"type": "string"
}
}
},
"schedule": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "schedule",
"type": "string",
"default": "schedule"
},
"id": {
"pattern": "schd_[0-9a-z]+",
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"every": {
"type": "integer"
},
"occurrences": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"on": {
"type": "object",
"properties": {
"days_of_month": {
"type": "array",
"items": {}
},
"weekday_of_month": {
"type": "string"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
}
}
},
"in_words": {
"type": "string"
},
"period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"status": {
"type": "string",
"enum": [
"running",
"active",
"expiring",
"expired",
"deleted",
"suspended"
]
},
"active": {
"type": "boolean",
"enum": [
true,
false
]
},
"state": {
"type": "string",
"enum": [
"Active",
"Pause"
]
},
"charge": {
"type": "object",
"properties": {
"object": {
"pattern": "charge_schedule",
"type": "string",
"default": "charge_schedule"
},
"id": {
"pattern": "rchg_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"default_card": {
"type": "boolean",
"enum": [
true,
false
]
},
"card": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"customer": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "customer",
"type": "string",
"default": "customer"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"metadata": {
"type": "object",
"default": {}
},
"cards": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"default_card": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"linked_accounts": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"description": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"linked_account": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "linked_account",
"type": "string",
"default": "linked_account"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"registration_uri": {
"type": "string",
"format": "uri"
},
"return_uri": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"deleted",
"pending",
"successful"
]
},
"last_digits": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"failure_code": {
"type": "string",
"nullable": true
},
"failure_message": {
"type": "string",
"nullable": true
},
"registered_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"description": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"transfer": {
"type": "object",
"properties": {
"object": {
"pattern": "transfer_schedule",
"type": "string",
"default": "transfer_schedule"
},
"id": {
"pattern": "rtrf_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"amount": {
"type": "integer",
"nullable": true
},
"currency": {
"type": "string",
"format": "currency"
},
"percentage_of_balance": {
"type": "number",
"format": "float",
"nullable": true
},
"recipient": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "recipient",
"type": "string",
"default": "recipient"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"bank_account": {
"type": "object",
"properties": {
"object": {
"pattern": "bank_account",
"type": "string",
"default": "bank_account"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"account_number": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"normal",
"current"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"brand": {
"type": "string"
},
"bank_code": {
"type": "string"
},
"branch_code": {
"type": "string"
}
}
},
"active": {
"type": "boolean",
"enum": [
true,
false
]
},
"default": {
"type": "boolean",
"enum": [
true,
false
]
},
"verified": {
"type": "boolean",
"enum": [
true,
false
]
},
"description": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"failure_code": {
"type": "string",
"nullable": true,
"enum": [
"name_mismatch",
"account_not_found",
"bank_not_found"
]
},
"name": {
"type": "string"
},
"tax_id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"individual",
"corporation"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"schedule": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "schedule",
"type": "string",
"default": "schedule"
},
"id": {
"pattern": "schd_[0-9a-z]+",
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"every": {
"type": "integer"
},
"occurrences": {
"$ref": "#/components/schemas/list"
},
"on": {
"$ref": "#/components/schemas/schedule_on"
},
"in_words": {
"type": "string"
},
"period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"status": {
"type": "string",
"enum": [
"running",
"active",
"expiring",
"expired",
"deleted",
"suspended"
]
},
"active": {
"type": "boolean",
"enum": [
true,
false
]
},
"state": {
"type": "string",
"enum": [
"Active",
"Pause"
]
},
"charge": {
"$ref": "#/components/schemas/charge_schedule"
},
"transfer": {
"$ref": "#/components/schemas/transfer_schedule"
},
"next_occurrences_on": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"ended_at": {
"type": "string",
"format": "date-time"
},
"start_on": {
"type": "string",
"format": "date"
},
"end_on": {
"type": "string",
"format": "date"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"execute_time": {
"type": "string",
"nullable": true
},
"deleted_by": {
"type": "string",
"nullable": true
},
"merchant_name": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"metadata": {
"type": "object",
"default": {}
},
"verified_at": {
"type": "string",
"format": "date-time"
},
"activated_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"is_realtime_payout": {
"type": "boolean",
"nullable": true,
"enum": [
true,
false
]
}
}
},
"next_occurrences_on": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"ended_at": {
"type": "string",
"format": "date-time"
},
"start_on": {
"type": "string",
"format": "date"
},
"end_on": {
"type": "string",
"format": "date"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"execute_time": {
"type": "string",
"nullable": true
},
"deleted_by": {
"type": "string",
"nullable": true
},
"merchant_name": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"linked_account": {
"type": "object",
"properties": {
"object": {
"pattern": "linked_account",
"type": "string",
"default": "linked_account"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"registration_uri": {
"type": "string",
"format": "uri"
},
"return_uri": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"deleted",
"pending",
"successful"
]
},
"last_digits": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"failure_code": {
"type": "string",
"nullable": true
},
"failure_message": {
"type": "string",
"nullable": true
},
"registered_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"customer": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "customer",
"type": "string",
"default": "customer"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"metadata": {
"type": "object",
"default": {}
},
"cards": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"default_card": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"linked_accounts": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"description": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"dispute": {
"type": "object",
"properties": {
"object": {
"pattern": "dispute",
"type": "string",
"default": "dispute"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"funding_amount": {
"type": "integer"
},
"funding_currency": {
"type": "string",
"format": "currency"
},
"metadata": {
"type": "object",
"default": {}
},
"charge": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "charge",
"type": "string",
"default": "charge"
},
"id": {
"pattern": "chrg_[0-9a-z]+",
"type": "string"
},
"location": {
"type": "string"
},
"amount": {
"type": "integer"
},
"authorization_type": {
"type": "string"
},
"authorized_amount": {
"type": "integer"
},
"captured_amount": {
"type": "integer"
},
"acquirer_reference_number": {
"type": "string",
"nullable": true
},
"net": {
"type": "integer"
},
"fee": {
"type": "integer"
},
"fee_vat": {
"type": "integer"
},
"interest": {
"type": "integer"
},
"interest_vat": {
"type": "integer"
},
"funding_amount": {
"type": "integer"
},
"refunded_amount": {
"type": "integer"
},
"transaction_fees": {
"type": "object",
"properties": {
"fee_flat": {
"type": "integer"
},
"fee_rate": {
"type": "number",
"format": "float"
},
"vat_rate": {
"type": "number",
"format": "float"
}
}
},
"platform_fee": {
"type": "object",
"properties": {
"fixed": {
"type": "integer"
},
"amount": {
"type": "integer"
},
"percentage": {
"type": "string"
}
}
},
"unmanaged_payment": {
"type": "object",
"properties": {
"authorization_code": {
"type": "string"
},
"backend_name": {
"type": "string"
},
"iin": {
"type": "string"
},
"merchant_reference": {
"type": "string"
}
}
},
"three_ds_info": {
"type": "object",
"properties": {
"three_ds_version": {
"type": "string"
},
"authenticated_at": {
"type": "string",
"format": "date-time"
},
"eci": {
"type": "string"
},
"transaction_status": {
"type": "string"
},
"acs_url": {
"type": "string"
}
}
},
"currency": {
"type": "string",
"format": "currency"
},
"funding_currency": {
"type": "string",
"format": "currency"
},
"ip": {
"type": "string",
"nullable": true
},
"refunds": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"link": {
"oneOf": [
{
"$ref": "#/components/schemas/link"
},
{
"type": "string"
}
]
},
"description": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"missing_3ds_fields": {
"type": "object"
},
"card": {
"type": "object",
"properties": {
"object": {
"pattern": "card",
"type": "string",
"default": "card"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"deleted": {
"type": "boolean",
"enum": [
true,
false
]
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true
},
"postal_code": {
"type": "string",
"nullable": true
},
"country": {
"pattern": "^[a-z]{0,2}$",
"type": "string"
},
"financing": {
"type": "string"
},
"bank": {
"type": "string"
},
"brand": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"first_digits": {
"pattern": "^[0-9]{6}$",
"type": "string",
"nullable": true
},
"last_digits": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"name": {
"type": "string"
},
"expiration_month": {
"type": "integer"
},
"expiration_year": {
"type": "integer"
},
"security_code_check": {
"type": "boolean",
"enum": [
true,
false
]
},
"tokenization_method": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"source": {
"type": "object",
"properties": {
"object": {
"pattern": "source",
"type": "string",
"default": "source"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"amount": {
"type": "integer"
},
"barcode": {
"type": "string"
},
"bank": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"currency": {
"type": "string",
"format": "currency"
},
"email": {
"type": "string"
},
"flow": {
"type": "string",
"enum": [
"redirect",
"offline",
"app_redirect"
]
},
"installment_term": {
"type": "integer"
},
"ip": {
"type": "string"
},
"absorption_type": {
"type": "string",
"enum": [
"merchant",
"customer"
]
},
"name": {
"type": "string"
},
"mobile_number": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"platform_type": {
"type": "string"
},
"scannable_code": {
"$ref": "#/components/schemas/barcode"
},
"qr_settings": {
"$ref": "#/components/schemas/sources_qr_settings"
},
"billing": {
"$ref": "#/components/schemas/source_billing"
},
"shipping": {
"$ref": "#/components/schemas/source_billing"
},
"items": {
"type": "array",
"items": {}
},
"references": {
"$ref": "#/components/schemas/source_references"
},
"provider_references": {
"$ref": "#/components/schemas/source_provider_references"
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"terminal_id": {
"type": "string"
},
"type": {
"type": "string"
},
"zero_interest_installments": {
"type": "boolean",
"enum": [
true,
false
]
},
"charge_status": {
"type": "string",
"enum": [
"failed",
"expired",
"pending",
"reversed",
"successful",
"unknown"
]
},
"receipt_amount": {
"type": "integer"
},
"discounts": {
"type": "array",
"items": {},
"default": []
},
"promotion_code": {
"type": "string"
},
"supplier_id": {
"type": "string"
}
}
},
"schedule": {
"oneOf": [
{
"$ref": "#/components/schemas/schedule"
},
{
"type": "string"
}
]
},
"linked_account": {
"type": "object",
"properties": {
"object": {
"pattern": "linked_account",
"type": "string",
"default": "linked_account"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"registration_uri": {
"type": "string",
"format": "uri"
},
"return_uri": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"deleted",
"pending",
"successful"
]
},
"last_digits": {
"type": "string",
"nullable": true
},
"metadata": {
"type": "object",
"default": {}
},
"failure_code": {
"type": "string",
"nullable": true
},
"failure_message": {
"type": "string",
"nullable": true
},
"registered_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
"customer": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"type": "string"
}
]
},
"dispute": {
"type": "object",
"properties": {
"object": {
"pattern": "dispute",
"type": "string",
"default": "dispute"
},
"id": {
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"location": {
"type": "string"
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"funding_amount": {
"type": "integer"
},
"funding_currency": {
"type": "string",
"format": "currency"
},
"metadata": {
"type": "object",
"default": {}
},
"charge": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
},
{
"type": "string"
}
]
},
"documents": {
"$ref": "#/components/schemas/list"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction"
}
},
"admin_message": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"reason_code": {
"type": "string",
"enum": [
"not_recorded",
"not_available",
"other",
"incorrect_transaction_amount",
"duplicate_processing",
"credit_not_processed",
"paid_by_other_means",
"unauthorized_charge",
"non_matching_account_number",
"incorrect_currency",
"late_presentment",
"cancelled_recurring_transaction",
"not_as_described_or_defective_merchandise",
"goods_or_services_not_provided",
"incorrect_transaction_code",
"invalid_data",
"expired_card",
"transaction_not_recognised"
]
},
"reason_message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"pending",
"won",
"lost"
]
},
"closed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
}
}
},
"transaction": {
"oneOf": [
{
"$ref": "#/components/schemas/transaction"
},
{
"type": "string"
}
]
},
"failure_code": {
"type": "string",
"nullable": true,
"enum": [
"failed_fraud_check",
"failed_processing",
"insufficient_balance",
"insufficient_fund",
"invalid_account_number",
"invalid_security_code",
"payment_cancelled",
"payment_rejected",
"timeout",
"expired_card"
]
},
"failure_message": {
"type": "string",
"nullable": true
},
"merchant_advice": {
"type": "string",
"nullable": true
},
"merchant_advice_code": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"pending",
"reversed",
"successful"
]
},
"authorize_uri": {
"type": "string",
"format": "uri",
"nullable": true
},
"return_uri": {
"type": "string",
"format": "uri",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"paid_at": {
"type": "string",
"format": "date-time"
},
"authorized_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expired_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reversed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"multi_capture": {
"type": "boolean",
"enum": [
true,
false
]
},
"zero_interest_installments": {
"type": "boolean",
"enum": [
true,
false
]
},
"authorized": {
"type": "boolean",
"enum": [
true,
false
]
},
"capturable": {
"type": "boolean",
"enum": [
true,
false
]
},
"capture": {
"type": "boolean",
"enum": [
true,
false
]
},
"disputable": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"refundable": {
"type": "boolean",
"enum": [
true,
false
]
},
"partially_refundable": {
"type": "boolean",
"enum": [
true,
false
]
},
"reversed": {
"type": "boolean",
"enum": [
true,
false
]
},
"reversible": {
"type": "boolean",
"enum": [
true,
false
]
},
"voided": {
"type": "boolean",
"enum": [
true,
false
]
},
"paid": {
"type": "boolean",
"enum": [
true,
false
]
},
"expired": {
"type": "boolean",
"enum": [
true,
false
]
},
"can_perform_void": {
"type": "boolean",
"enum": [
true,
false
]
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
},
"approval_code": {
"type": "string",
"nullable": true
},
"statement_descriptor": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"documents": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"pattern": "transaction",
"type": "string",
"default": "transaction"
},
"id": {
"pattern": "trxn_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"location": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"credit",
"debit"
]
},
"key": {
"type": "string"
},
"origin": {
"type": "string"
},
"transferable_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
},
"admin_message": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"reason_code": {
"type": "string",
"enum": [
"not_recorded",
"not_available",
"other",
"incorrect_transaction_amount",
"duplicate_processing",
"credit_not_processed",
"paid_by_other_means",
"unauthorized_charge",
"non_matching_account_number",
"incorrect_currency",
"late_presentment",
"cancelled_recurring_transaction",
"not_as_described_or_defective_merchandise",
"goods_or_services_not_provided",
"incorrect_transaction_code",
"invalid_data",
"expired_card",
"transaction_not_recognised"
]
},
"reason_message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"pending",
"won",
"lost"
]
},
"closed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
}
}
},
"transaction": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "transaction",
"type": "string",
"default": "transaction"
},
"id": {
"pattern": "trxn_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"location": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"credit",
"debit"
]
},
"key": {
"type": "string"
},
"origin": {
"type": "string"
},
"transferable_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"failure_code": {
"type": "string",
"nullable": true,
"enum": [
"failed_fraud_check",
"failed_processing",
"insufficient_balance",
"insufficient_fund",
"invalid_account_number",
"invalid_security_code",
"payment_cancelled",
"payment_rejected",
"timeout",
"expired_card"
]
},
"failure_message": {
"type": "string",
"nullable": true
},
"merchant_advice": {
"type": "string",
"nullable": true
},
"merchant_advice_code": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"pending",
"reversed",
"successful"
]
},
"authorize_uri": {
"type": "string",
"format": "uri",
"nullable": true
},
"return_uri": {
"type": "string",
"format": "uri",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"paid_at": {
"type": "string",
"format": "date-time"
},
"authorized_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expired_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reversed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"multi_capture": {
"type": "boolean",
"enum": [
true,
false
]
},
"zero_interest_installments": {
"type": "boolean",
"enum": [
true,
false
]
},
"authorized": {
"type": "boolean",
"enum": [
true,
false
]
},
"capturable": {
"type": "boolean",
"enum": [
true,
false
]
},
"capture": {
"type": "boolean",
"enum": [
true,
false
]
},
"disputable": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"refundable": {
"type": "boolean",
"enum": [
true,
false
]
},
"partially_refundable": {
"type": "boolean",
"enum": [
true,
false
]
},
"reversed": {
"type": "boolean",
"enum": [
true,
false
]
},
"reversible": {
"type": "boolean",
"enum": [
true,
false
]
},
"voided": {
"type": "boolean",
"enum": [
true,
false
]
},
"paid": {
"type": "boolean",
"enum": [
true,
false
]
},
"expired": {
"type": "boolean",
"enum": [
true,
false
]
},
"can_perform_void": {
"type": "boolean",
"enum": [
true,
false
]
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
},
"approval_code": {
"type": "string",
"nullable": true
},
"statement_descriptor": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"documents": {
"type": "object",
"properties": {
"object": {
"pattern": "list",
"type": "string",
"default": "list"
},
"data": {
"type": "array",
"items": {}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"location": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"chronological",
"reverse_chronological"
]
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"pattern": "transaction",
"type": "string",
"default": "transaction"
},
"id": {
"pattern": "trxn_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"location": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"credit",
"debit"
]
},
"key": {
"type": "string"
},
"origin": {
"type": "string"
},
"transferable_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
},
"admin_message": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"reason_code": {
"type": "string",
"enum": [
"not_recorded",
"not_available",
"other",
"incorrect_transaction_amount",
"duplicate_processing",
"credit_not_processed",
"paid_by_other_means",
"unauthorized_charge",
"non_matching_account_number",
"incorrect_currency",
"late_presentment",
"cancelled_recurring_transaction",
"not_as_described_or_defective_merchandise",
"goods_or_services_not_provided",
"incorrect_transaction_code",
"invalid_data",
"expired_card",
"transaction_not_recognised"
]
},
"reason_message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"pending",
"won",
"lost"
]
},
"closed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
}
}
},
"transaction": {
"oneOf": [
{
"type": "object",
"properties": {
"object": {
"pattern": "transaction",
"type": "string",
"default": "transaction"
},
"id": {
"pattern": "trxn_[0-9a-z]+",
"type": "string"
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"currency": {
"type": "string",
"format": "currency"
},
"amount": {
"type": "integer"
},
"location": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"credit",
"debit"
]
},
"key": {
"type": "string"
},
"origin": {
"type": "string"
},
"transferable_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "string"
}
]
},
"failure_code": {
"type": "string",
"nullable": true,
"enum": [
"failed_fraud_check",
"failed_processing",
"insufficient_balance",
"insufficient_fund",
"invalid_account_number",
"invalid_security_code",
"payment_cancelled",
"payment_rejected",
"timeout",
"expired_card"
]
},
"failure_message": {
"type": "string",
"nullable": true
},
"merchant_advice": {
"type": "string",
"nullable": true
},
"merchant_advice_code": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"failed",
"expired",
"pending",
"reversed",
"successful"
]
},
"authorize_uri": {
"type": "string",
"format": "uri",
"nullable": true
},
"return_uri": {
"type": "string",
"format": "uri",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"paid_at": {
"type": "string",
"format": "date-time"
},
"authorized_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expired_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reversed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"multi_capture": {
"type": "boolean",
"enum": [
true,
false
]
},
"zero_interest_installments": {
"type": "boolean",
"enum": [
true,
false
]
},
"authorized": {
"type": "boolean",
"enum": [
true,
false
]
},
"capturable": {
"type": "boolean",
"enum": [
true,
false
]
},
"capture": {
"type": "boolean",
"enum": [
true,
false
]
},
"disputable": {
"type": "boolean",
"enum": [
true,
false
]
},
"livemode": {
"type": "boolean",
"enum": [
true,
false
]
},
"refundable": {
"type": "boolean",
"enum": [
true,
false
]
},
"partially_refundable": {
"type": "boolean",
"enum": [
true,
false
]
},
"reversed": {
"type": "boolean",
"enum": [
true,
false
]
},
"reversible": {
"type": "boolean",
"enum": [
true,
false
]
},
"voided": {
"type": "boolean",
"enum": [
true,
false
]
},
"paid": {
"type": "boolean",
"enum": [
true,
false
]
},
"expired": {
"type": "boolean",
"enum": [
true,
false
]
},
"can_perform_void": {
"type": "boolean",
"enum": [
true,
false
]
},
"merchant_name": {
"type": "string"
},
"merchant_uid": {
"type": "string"
},
"approval_code": {
"type": "string",
"nullable": true
},
"statement_descriptor": {
"type": "string"
}
}